NAME¶

PAPI_set_granularity - set the default counting granularity for eventsets bound to the cpu component
PAPI_set_cmp_granularity - set the default counting granularity for eventsets bound to the specified component

SYNOPSIS¶

C Interface

#include <papi.h>
int PAPI_set_granularity(int granularity);
int PAPI_set_cmp_granularity(int granularity",int cidx );

Fortran Interface

#include fpapi.h
PAPIF_set_granularity(C_INT granularity, C_INT check)

DESCRIPTION¶

PAPI_set_granularity sets the default counting granularity for all new event sets created by PAPI_create_eventset(3). This call implicitly sets the granularity for the cpu component (component 0) and is included to preserve backward compatibility.

PAPI_set_cmp_granularity sets the default counting granularity for all new event sets,
and requires an explicit component argument.
Event sets that are already in existence are not affected. To change the granularity of an existing event set, please see the PAPI_set_opt(3) man page. The reader should note that the granularity of an event set affects only the mode in which the counter continues to run.

ARGUMENTS¶

cidx -- An integer identifier for a component. By convention, component 0 is always the cpu component.

granularity -- one of the following constants as defined in the papi.h header file:

RETURN VALUES¶

On success, this function returns PAPI_OK.
On error, a non-zero error code is returned.

ERRORS¶

PAPI_EINVAL

One or more of the arguments is invalid.

PAPI_ENOEVST

The event set specified does not exist.

PAPI_ENOCMP

The argument cidx is not a valid component.

PAPI_EISRUN

The event set is currently counting events.

EXAMPLES¶

int retval;
/* Initialize the library */
retval = PAPI_library_init(PAPI_VER_CURRENT);
if (retval > 0 && retval != PAPI_VER_CURRENT) {


  fprintf(stderr,"PAPI library version mismatch!0);


  exit(1); }
if (retval < 0) 


  handle_error(retval);
/* Set the default granularity for the cpu component */
if ((retval = PAPI_set_cmp_granularity(PAPI_GRN_PROC,0)) != PAPI_OK)


  handle_error(retval);
if ((retval = PAPI_create_eventset(&EventSet)) != PAPI_OK)


  handle_error(retval);

BUGS¶

This function has no known bugs.

SEE ALSO¶

PAPI_set_domain(3), PAPI_set_opt(3), PAPI_get_opt(3)